Infrastructure Acknowledgement
The purpose of the Infrastructure Acknowledgement is to inform the sender that the payload has been delivered to a component that has processed and validated the Distribution Envelope.
An Infrastructure Acknowledgement is requested by the message sender setting a Distribution Envelope handling specification with key="urn:nhs-itk:ns:201005:infackrequested" and value="true"
ITK Infrastructure Acknowledgement (urn:nhs-itk:interaction:ITKInfrastructureAcknowledgement-v1-0)
| Sender: | ITK Infrastructure Acknowledgement (Version 1.0) | View |
|---|---|---|
| Receiver: | no defined responsibilities | N/A |
| Message: | Wire Format | View |
| Transmission Wrapper | ITK Distribution Envelope | View |
Schema
| Item | |
|---|---|
| ITK Infrastructure Acknowledgement (Version 1.0) | View |
Elements and Attributes of the Infrastructure Acknowledgement
| Name | Cardinality | Data Type | Description |
|---|---|---|---|
| InfrastructureResponse | 1..1 | Root element for the response. | |
| @result | 1..1 | Code | The actual response code. |
| @timestamp | 0..1 | dateTime | The time at which the error was generated. |
| @trackingIdRef | 1..1 | UUID | The tracking id taken from the distribution envelope of the message being acknowledged. |
| @serviceRef | 1..1 | URI | A reference to the original service used to send the message. |
| reportingIdentity | 1..1 | An reference to the reporter. Examples could include an ITK format address, a spine smart-card authentication etc. | |
| id | 1..4 | Up to 4 levels of identity are allowed to identify the reporter. For example the 1st identity could be a person, 2nd their role, and 3rd the responsible organisation. | |
| @type | 0..1 | String | The format of identity used. (default= "2.16.840.1.113883.2.1.3.2.4.18.27", which indicates an ITK identity format). Other identity formats are supported, but these are generally used by local agreement. For sending an inter-organisational transmission, the default ITK identity format should be used. |
| @uri | 1..1 | URI | The actual reporter identification. |
| errors | 1..1 | The list of errors which occurred. | |
| errorInfo | 0..* | Individual error items. | |
| ErrorID | 1..1 | URI | An identifier for the error. |
| ErrorCode | 1..1 | String | A code indicating the type of error. |
| @codeSystem | 0..1 | String | The code system from which the code is drawn (2.16.840.1.113883.2.1.3.2.4.17.516 - ToolkitErrorCodes). |
| ErrorText | 1..1 | String | Display text associated with the error code. |
| ErrorDiagnosticText | 0..1 | String | A free text field used to clarify the error. |